Node / meshtastic / Meshtastic-Android / files / docs / assets / screenshots / README.md

Displaying Raw • View rendered • Download

Tc9d1d9# Screenshots

This directory contains screenshot assets referenced by the documentation pages.

Screenshots are sourced from the Compose Preview Screenshot Testing reference images

in Ta5d6ff`screenshot-tests/src/screenshotTestDebug/reference/`. Light-mode variants are

copied here for use by the Jekyll docs site and in-app documentation browser.

Tc9d1d9## Updating Screenshots

After changing a UI component, regenerate reference images and copy them here:

Ta5d6ff```Ta5d6ffbash

./gradlew :screenshot-tests:updateDebugScreenshotTest

Ta5d6ff```

Then copy the relevant light-mode PNGs from the reference directory. The

Ta5d6ff`copyDocsScreenshots` task automates bulk copying based on the manifest:

Ta5d6ff```Ta5d6ffbash

./gradlew :screenshot-tests:copyDocsScreenshots

Ta5d6ff```

Tc9d1d9## Naming Convention

Ta5d6ff```

{page-id}_{description}.png

```

Examples:

Tff7b72- Ta5d6ff`onboarding_welcome.png`

Tff7b72- Ta5d6ff`connections_bluetooth_scan.png`

Tff7b72- Ta5d6ff`firmware_disclaimer.png`

Tc9d1d9## Guidelines

Tff7b72- PNG format, light-mode only (dark variants live in reference directory)

Tff7b72- Name screenshots to match the docs page they appear in

Tff7b72- Keep filenames lowercase with underscores